/**
 * Copyright 2010 Tristan Slominski
 *
 * Licensed under the MIT License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.opensource.org/licenses/mit-license.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mindash.handlebars.client.pages;

import com.google.gwt.user.client.Timer;
import com.mindash.handlebars.client.events.handlers.RefreshViewEventHandler;
import com.mindash.handlebars.client.places.GoToPlace;
import com.mindash.handlebars.client.presenters.ParentPresenter;

/**
 * @author Tristan Slominski
 * 
 */
public interface Page extends ParentPresenter, RefreshViewEventHandler{

  /**
   * Displays the page to the customer. Takes care of notifying child presenters
   * of the current place via {@code createView()}..
   */
  public void displayPage();

  /**
   * Redirects to the place after given number of seconds.
   * 
   * @param goTo the place to go to
   * @param secondsDelay the delay in seconds
   * @return timer object, no need to do anything with it, calling the method is
   * sufficient
   */
  public Timer redirect(final GoToPlace<?> goTo, int secondsDelay);

  /**
   * Refreshes the view without calling onAtPlace on child presenters
   */
  public void refreshPage();

}
